﻿////-----------------------------------------------------------------------
//// <copyright company="www.3WayWebdesign.de">
//// Permission is hereby granted, free of charge, to any person obtaining
//// a copy of this software and associated documentation files (the
//// "Software"), to deal in the Software without restriction, including
//// without limitation the rights to use, copy, modify, merge, publish,
//// distribute, sublicense, and/or sell copies of the Software, and to
//// permit persons to whom the Software is furnished to do so, subject to
//// the following conditions:
////
//// The above copyright notice and this permission notice shall be
//// included in all copies or substantial portions of the Software.
//// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
//// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
//// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
//// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//// </copyright>
////
//// <author>Michael Morbach</author>
//// <email>Michael@3waywebdesign.de</email>
//// <web>http://www.3waywebdesign.de</web>
////-----------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Linq;
using System.Text;
using GalaSoft.MvvmLight;
using Tww.MAF.MAFEngine.Common;

namespace Tww.MAF.MAFEngine.Navigator
{
    public interface INavigationJournal : INotifyCollectionChanged, INotifyPropertyChanged, INotifyPropertyChanging, ICleanup
    {
        /// <summary>
        /// Gets a value that indicates whether there is at least one entry in the back navigation history.
        /// </summary>
        /// <value>
        /// <c>true</c> if the journal can go back; otherwise, <c>false</c>.
        /// </value>
        bool CanGoBack { get; }

        /// <summary>
        /// Gets the back stack.
        /// </summary>
        /// <value>
        /// The back stack.
        /// </value>
        Stack<INavigationJournalEntry> BackStack { get; }

        /// <summary>
        /// Gets the forward stack.
        /// </summary>
        /// <value>
        /// The forward stack.
        /// </value>
        Stack<INavigationJournalEntry> ForwardStack { get; }

        /// <summary>
        /// Gets a value that indicates whether there is at least one entry in the forward navigation history.
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance can go forward; otherwise, <c>false</c>.
        /// </value>
        bool CanGoForward { get; }

        /// <summary>
        /// Gets the current navigation entry of the content that is currently displayed.
        /// </summary>
        /// <value>The current entry.</value>
        INavigationJournalEntry CurrentEntry { get; }

        /// <summary>
        /// Navigates to the most recent entry in the back navigation history, or does nothing if no entry exists in back navigation.
        /// </summary>
        void GoBack();

        /// <summary>
        /// Navigates to the most recent entry in the forward navigation history, or does nothing if no entry exists in forward navigation.
        /// </summary>
        void GoForward();

        /// <summary>
        /// Navigates directly to the specified entry
        /// </summary>
        /// <param name="journalEntry">The entry to record</param>
        void GoTo(INavigationJournalEntry journalEntry);

        /// <summary>
        /// Records the navigation to the entry..
        /// </summary>
        /// <param name="journalEntry">The entry to record.</param>
        void RecordNavigation(INavigationJournalEntry journalEntry);

        /// <summary>
        /// Clears the journal of current, back, and forward navigation histories.
        /// </summary>
        void Clear();
    }
}
